home *** CD-ROM | disk | FTP | other *** search
/ Aminet 51 / Aminet 51 (2002)(GTI - Schatztruhe)[!][Oct 2002].iso / Aminet / util / arc / xadmasterdev.lha / xad / Include / ReadMe.TXT
Encoding:
Text File  |  2002-08-20  |  2.7 KB  |  60 lines
  1. xadmaster.library got a design which is a result of programming for
  2. xfdmaster.library, programming xpkmaster.library and fd2pragma tool. I got
  3. some problems with these and tried to fix them for xadmaster.library.
  4. I hope I got all :-) We will see in some years.
  5.  
  6. The library has a very open interface allowing future enhancements easily.
  7. Nearly all funtions get their arguments through TagItem structures and
  8. all structures must be allocated through xadmaster.library which ensures
  9. the ability to expand them. The functions using Tag arrays end with A.
  10. Related varargs functions end without A, but are not supported on all
  11. compilers directly. Use fd2pragma to create link libraries for e.g.
  12. MaxonC++ compiler.
  13.  
  14. The library is done in pure C code compiled with SAS-C. It does not use
  15. global variables and library bases or the ExecBase pointer from 4.W. All
  16. the necessary data is stored locally. All library functions use the normal
  17. library interface for their work (e.g. xadGetInfo does not call
  18. xadAllocObject internally, but with normal library call).
  19.  
  20. The library base pointers stored in xadMasterBase should be used from
  21. clients only. No other programs should access them to ensure future
  22. compatibility!
  23.  
  24. If you need additionally include files, use fd2pragma utility. It can be
  25. found in Aminet under name dev/misc/fd2pragma.lha.
  26.  
  27. It is able to produce stub libraries, lvo, proto and pragma files and a lot
  28. of other stuff.
  29.  
  30. The inline files in directory inline will work with GCC and VBCC.
  31. The pragma files will work with SAS, Maxon, Storm, Dice and Aztec compiler.
  32. The proto files will work with all of these compilers!
  33.  
  34. Most of these files were automatically created with fd2pragma (2.139 or
  35. better):
  36. fd2pragma SPECIAL   6 INFILE SFD/xadmaster_lib.sfd TO C/pragma
  37. fd2pragma SPECIAL  18 INFILE SFD/xadmaster_lib.sfd TO AmigaE/
  38. fd2pragma SPECIAL  40 INFILE SFD/xadmaster_lib.sfd TO C/inline
  39. fd2pragma SPECIAL  38 INFILE SFD/xadmaster_lib.sfd TO C/proto
  40. fd2pragma SPECIAL  70 INFILE SFD/xadmaster_lib.sfd TO C/inline
  41. fd2pragma SPECIAL  23 INFILE SFD/xadmaster_lib.sfd TO ASM/lvo
  42. fd2pragma SPECIAL 110 INFILE SFD/xadmaster_lib.sfd TO FD COMMENT
  43. fd2pragma SPECIAL 111 INFILE SFD/xadmaster_lib.sfd TO C/clib COMMENT COPYRIGHT "Dirk Stöcker"
  44.  
  45. For GCC you may delete the pragma directory.
  46. For all the other C compilers you may delete the inline directory,
  47. but use pragma instead. Do not rename pragma to pragmas or change
  48. the file names! When pragma does not exist, please create it.
  49.  
  50. Always call files in proto directory instead of clib, inline or pragma
  51. directory! This makes usage of different compilers possible.
  52.  
  53. You need not to modify any of the include files or change their names!
  54.  
  55.  
  56. Dirk Stöcker <stoecker@epost.de>
  57.  
  58. 13th December 2001
  59.  
  60.